Skip to content

docs: rewrite README as a standard npm CLI readme#3

Merged
ofekby merged 1 commit into
mainfrom
readme-polish
May 31, 2026
Merged

docs: rewrite README as a standard npm CLI readme#3
ofekby merged 1 commit into
mainfrom
readme-polish

Conversation

@ofekby
Copy link
Copy Markdown
Member

@ofekby ofekby commented May 31, 2026

Summary

Replaces the three-line placeholder README with a standard npm-CLI README, so the package page on npmjs.com is presentable.

  • Fixes the install URL — was curl -fsSL https://dial.up.railway.app/install | bash (a Railway preview host); now https://getdial.ai/install (verified 200).
  • Drops the internal reference to docs/superpowers/specs/... — not relevant to package consumers.
  • Adds the usual sections: intro, installation (npm + bootstrap), quick start, a commands table, configuration/env vars, "use from an AI agent" (the skill install), a docs link, and license.
  • All doc links verified to resolve (200): the CLI reference, listen service, and CLI Skill pages.

Docs-only change (no src/ or package.json edit), so no version bump is required.

Test plan

  • README renders cleanly on GitHub and the npm package page
  • All links resolve

🤖 Generated with Claude Code

@ofekby ofekby merged commit 1be7a69 into main May 31, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant